docs: Improve documentation for macros#276
Open
Siel wants to merge 3 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands public-facing Rustdoc documentation for the optimize module and for the macro-based entrypoints (ode!, analytical!, sde!) that are re-exported from the main pharmsol crate, addressing the “complete the API documentation” request from issue #273.
Changes:
- Added module-level Rustdoc for
src/optimizeand its key submodules (effect,parameters). - Added detailed Rustdoc (including field tables and examples) for the
ode!,analytical!, andsde!procedural macros.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/optimize/parameters.rs | Adds module and API docs for ParameterOptimizer. |
| src/optimize/mod.rs | Adds top-level optimize module docs and submodule descriptions. |
| src/optimize/effect.rs | Adds module docs describing the get_e2 entrypoint. |
| pharmsol-macros/src/lib.rs | Adds Rustdoc for ode!, analytical!, and sde! proc macros (fields + examples). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+1
to
+7
| //! Nelder‑Mead parameter refinement for pharmacometric models. | ||
| //! | ||
| //! This module provides a [`ParameterOptimizer`] that refines a single parameter | ||
| //! Given an [`Equation`], observed [`Data`], and [`AssayErrorModels`] via | ||
| //! Nelder‑Mead optimization in log‑space. The optimizer finds the parameter vector | ||
| //! that minimizes the negative log-likelihood of the model predictions against the data, | ||
| //! as measured by the provided error models. |
Contributor
|
Bencher Report| Branch | 273-complete-the-api-documentation |
| Testbed | mhovd-pgx |
⚠️ WARNING: Truncated view!The full continuous benchmarking report exceeds the maximum length allowed on this platform.
🚨 2 Alerts
🐰 View full continuous benchmarking report in Bencher
Mostly related to doc links Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
mhovd
approved these changes
Jun 18, 2026
mhovd
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…ptimize module. #273
This PR aims to close #273